home *** CD-ROM | disk | FTP | other *** search
/ Inside Mac Games Volume 3 #9 / IMG 30 Sep 1995.iso / More Goodies / Cheaters, Editors, et al. / Marathon Utilities / Shape Shifter / Alrighty Then! next >
Text File  |  1995-08-03  |  11KB  |  380 lines
  1. (This is a very VERY rough draft of the planned documentation for Shape Shifter. Better documentation can be gotten online at:
  2.  
  3. http://museum.cl.msu.edu/~hndrcksn/Shape_Shifter.html
  4.  
  5.                               Shape Shifter 0.8
  6.  
  7. Copyright © 1995 Kevin Hendrickson. All rights reserved.
  8. Marathon is a trademark of Bungie Software.
  9. Photoshop is a trademark of Adobe Software.
  10.  
  11. Note: Any discussion about the inner workings of Marathon in this document
  12. is pure conjecture on my part. I am in no way affiliated with Bungie and
  13. have no inside knowledge about the way Marathon works.
  14.  
  15. This application is a Shapes file editor for Marathon. In addition to the
  16. typical capabilities of other editors, such as copying and pasting
  17. individual images, Shape Shifter allows you to graphically edit the images.
  18.  
  19. Features:
  20.  
  21.    *  Create new Shapes files, resources, color palettes, High Level, Low
  22.      Level, Images from scratch
  23.  
  24.    *  View all images of the current resource being edited in a scrollable
  25.      view area.
  26.  
  27.    *  Edit numerical characteristics of the current resource being edited in
  28.      a convenient floating palette.
  29.  
  30.    *  Graphic editing environment including easel/paint area, typical
  31.      painting tools, etc. for direct manipulation of images.
  32.  
  33.    *  One level of undo for all graphic actions.
  34.  
  35.    *  Balloon Help.
  36.  
  37.    *  Palette manipulation including editing current palette, creating new
  38.      palette, copy/paste palette in clipboard, load/save cluts in Photoshop
  39.      format.
  40.  
  41.    *  View animation sequences in special Animation window. Changes to
  42.      images are automatically updated as sequences run.
  43.  
  44.    *  Open, view and copy PICT files.
  45.  
  46. You may want to view information about the following components of Shape
  47. Shifter in further detail.
  48.  
  49.  
  50. Shape Editor Overview:
  51.  
  52. The Shape Editor is an editing environment from which you can edit all the
  53. characteristics of the '.256' resource in a Shapes file. The window contains
  54. a number of elements conducive to the direct manipulation of all
  55. characteristics of the resource.
  56.  
  57. Resource
  58.  
  59. This popup menu contains a list of a subset of the resources in the current
  60. shapes file. Which subset is present is determined by the Class radio set
  61. described below. The menu can display resource names or IDs - an option
  62. select in the Preferences window. To choose a new resource to edit, simply
  63. choose its name or ID number from the menu.
  64.  
  65. Palette
  66.  
  67. This popup menu contains a list of the color palettes in the current
  68. resource. The number is just an indication of its position in the resource.
  69. Choosing a number from the menu will update the colors in the Image View
  70. area, Easel, the Color Palette, the Tool Palette, and the Animation Palette.
  71. You can edit colors individually from the Color Palette or more
  72. comprehensively from the Color Palette Editor.
  73.  
  74. Zoom
  75.  
  76. This popup menu controls the pixel resolution of the Easel. Currently only 5
  77. sizes are supported - 0.25, 0.5, 1, 2, 4. Zooming in allows close up pixel
  78. by pixel editing.
  79.  
  80. Class
  81.  
  82. This set of radio buttons controls/shows the class of the current resource.
  83. The chosen class affects the list of resources displayed in the Resource
  84. popup. Choosing a different class will change the list of resources in the
  85. Resource popup and load another resource if the current resource os of a
  86. different type. Choosing "All" will list all resources of the current Shapes
  87. file in the Resource popup.
  88.  
  89. Images
  90.  
  91. This is the Image View area containing a list of thumbnails representing the
  92. images in the current resource. To edit an image, cmd-drag its thumbnail
  93. into the Easel and press cmd-D or Select None from the Edit menu or click
  94. outside of the selection with the arrow cursor, to paste it into the Easel.
  95. You can reorder the images by dragging one on top of another. You can remove
  96. an image by selecting the thumbnail and pressing the delete key or selecting
  97. Clear from the Edit menu. You can replace an image by making a selection in
  98. the Easel and cmd-dragging the selection onto the thumbnail. To edit some
  99. numerical characteristics of an image, just double-click to launch the
  100. Shapes Palette. To add a new image hit cmd-I or select New Image from the
  101. Shapes menu.
  102.  
  103. Low Shapes
  104.  
  105. This scrolling list contains the low level shapes contained in the current
  106. resource. Low level shapes contain additional information used by Marathon
  107. for controlling positioning, lighting, etc. of a sprite. The low level
  108. shapes are listed in the order they appear in the resource. You can
  109. rearrange the order of the shapes by simply dragging them around in the
  110. list. They retain the numbers that they had when the resource was first
  111. loaded so that you can see what you've changed, but their correct positions
  112. will be saved with the resource. To edit the numerical values of a low level
  113. shape just double-click on it or select Shapes from the Palette menu to
  114. launch the Shape Palette. To delete a low level shape, select it and hit the
  115. delete key. To add a new low level shape hit cmd-L or select New Low Level
  116. Shape from the Shapes menu.
  117.  
  118. High Shapes
  119.  
  120. This scrolling list contains the high level shapes contained in the current
  121. resource. High level shapes contain information used by Marathon for
  122. animating sprites. The high level shapes are listed by name in the order
  123. they appear in the resource. You can rearrange the order of the shapes by
  124. simply dragging them around in the list. To edit the values of a high level
  125. shape just double-click on it or select Shapes from the Palette menu to
  126. launch the Shapes Palette. To delete a high level shape, select it and hit
  127. the delete key. To add a new high level shape hit cmd-H or select New High
  128. Level Shape from the Shapes menu.
  129.  
  130. Link Shapes Palette
  131.  
  132. When this check box is checked, clicking on an item in the Low Shapes or
  133. High Shapes areas or clicking on a thumbnail in the Images area results in
  134. an corresponding update of the information in the Shapes Palette if it is
  135. currently open.
  136.  
  137. Easel
  138.  
  139. This is the paint area where you can edit images. This is not intended to be
  140. a substitute for Photoshop or any other commercial graphics editing program.
  141. Its main purpose is to allow you to make quick changes to your images so
  142. that you can see immediate results. You can use the various tools present in
  143. the Tool Palette to edit your images. The Zoom popup menu allows you to zoom
  144. in for pixel-by-pixel editing.
  145.  
  146.  
  147. Quick Menu Overview:
  148.  
  149. File
  150.  
  151. New
  152.  
  153. - Create a new Shapes file here. The Shapes file created is really an empty
  154. shell. You have to add resources to it to make it into a real shapes file.
  155. You will also need to copy the 'clut' and 'PICT' resources that Marathon
  156. expects to find there.
  157.  
  158. Open...
  159.  
  160. - Opens an existing Shapes file.
  161.  
  162. Close
  163.  
  164. - Closes the Shapes file. You are prompted to save outstanding changes to
  165. the current resource.
  166.  
  167. Save
  168.  
  169. - Save changes to Shapes file. These are the changes in the resource that is
  170. currently being edited.
  171.  
  172. Save As...
  173.  
  174. - ditto but with new name???(I haven't decided yet.)
  175.  
  176. Revert
  177.  
  178. - not currently implemented
  179.  
  180. Page Setup...
  181.  
  182. - not currently implemented
  183.  
  184. Print...
  185.  
  186. - not currently implemented
  187.  
  188. Quit
  189.  
  190. - quit application. Duh!
  191.  
  192. Edit
  193.  
  194. Undo/Redo
  195.  
  196. - undoes/redoes last paint stroke, text action or move action. This is
  197. context sensitive. If you are in a text box then the typical text editing
  198. commands can be un/redone. If you have just performed a paint stroke or
  199. moved a selection then undo/redo affects those actions.
  200.  
  201. Cut
  202.  
  203. - cuts the current selection to the clipboard (text or graphic). If a
  204. graphic is cut then the 'PICT' and 'clut' resource are copied to the
  205. clipboard.
  206.  
  207. Copy
  208.  
  209. - copies the current selection to the clipboard (text or graphic). If a
  210. graphic is cut then the 'PICT' and 'clut' resource are copied to the
  211. clipboard.
  212.  
  213. Paste
  214.  
  215. - pastes image, palette or text from the clipboard
  216.  
  217. Clear
  218.  
  219. - clears current selection (text or graphic)
  220.  
  221. Select All
  222.  
  223. - selects all text
  224.  
  225. Select None
  226.  
  227. - deselects current graphic selection. This is the one way to drop a graphic
  228. into the Easel. Just clicking outside of the selection with the arrow cursor
  229. is another way.
  230.  
  231. Resize Easel...
  232.  
  233. - resets the size of the easel painting area. Minimum size is 50x50 pixels,
  234. maximum is 1000x1000. The size you chose may greatly affect the amount of
  235. memory Shape Shifter has left over, so make sure you have given Shape
  236. Shifter enough memory to begin with. You may choose to erase the current
  237. area or not.
  238.  
  239. Set Pen Size...
  240.  
  241. - horizontally/vertically resizes the graphic pen of the currently selected
  242. painting tool. Minimum size is 1x1, maximum is 16x16. I intend to use a
  243. better method for changing pen size soon. So this menu item won't be around
  244. for long.
  245.  
  246. Edit Palette...
  247.  
  248. - calls up the Color Palette Editor for editing the current color palette.
  249.  
  250. Preferences...
  251.  
  252. - this launches the Preferences window which allows you to set/change a
  253. variety of Shape Shifter characteristics.
  254.  
  255. Mem Debugger
  256.  
  257. - this launches the memory display window currently used for debugging
  258. purposes.
  259.  
  260. Palettes
  261.  
  262. Animation
  263.  
  264. - opens the Animation Palette.
  265.  
  266. Color
  267.  
  268. - opens the Color Palette.
  269.  
  270. Mouse Tracker
  271.  
  272. - opens the Mouse Tracker.
  273.  
  274. Shapes
  275.  
  276. - opens the Shapes Palette.
  277.  
  278. Tools
  279.  
  280. - opens the Tool Palette used for editing images.
  281.  
  282. Shapes
  283.  
  284. New High Level Shape
  285.  
  286. - creates a new High Level Shape with default numerical values. The new
  287. object is placed at the end of the Low Shapes scrolling list in the Shape
  288. Editor.
  289.  
  290. New Low Level Shape
  291.  
  292. - creates a new Low Level Shape with default numerical values. The new
  293. object is placed at the end of the High Shapes scrolling list in the Shape
  294. Editor.
  295.  
  296. New Image
  297.  
  298. - creates a new image slot in the Image View area in the Shape Editor.
  299.  
  300. New Palette
  301.  
  302. - launches the Color Palette Editor with a newly created color palette. The
  303. colors are copied from the currently selected palette. The new color palette
  304. is saved at the end of the list in the Palette popup menu of the Shape
  305. Editor.
  306.  
  307. Resources
  308.  
  309. New Resource
  310.  
  311. - creates a new resource. Initially asks which class of shape to create,
  312. then creates the resource with default values. New palettes, images, High
  313. and Low Level shapes must be added to a resource before it is complete.
  314.  
  315. Rename Resource...
  316.  
  317. - changes the name of the current resource. All unnamed resources are given
  318. the default name "Unnamed #x", where "x" is a number. The resource is not
  319. given a real name until you change the name and save the resource. Resource
  320. names are NOT checked for uniqueness.
  321.  
  322. Renumber Resource...
  323.  
  324. - changes the number of the current resource. Checks to make sure the number
  325. is unique.
  326.  
  327. Delete Resource
  328.  
  329. - deletes the current resource.
  330.  
  331. Duplicate Resource
  332.  
  333. - duplicates the current resource. Any further editing is done on the
  334. duplicate.
  335.  
  336. Home |Shape Editor |Palettes |Bug Report
  337.  
  338. Shape Shifter Palettes
  339.  
  340. Shape Shifter has a number of palettes used for editing the shapes in the
  341. resources and their images.
  342.  
  343. Copyright for Shape Shifter
  344.  
  345. This version (0.8dX) is a development version of Shape Shifter and is
  346. freeware. You may freely distribute the software with the following
  347. restrictions: you must include any instructions that come with the package
  348. and you may not distribute this software as part of a CD ROM collection or
  349. for any commercial purposes without my expressed written permission.
  350.  
  351. ----------------------------------------------------------------------------
  352.  
  353. Shape Shifter Bug Report
  354.  
  355.  
  356. Name:
  357.  
  358. E-mail:
  359.  
  360. OS version:
  361.  
  362. Hardware Platform:  Other platform:
  363.  
  364. Do you use an Accelerator?
  365.  
  366. Cache Card?
  367.  
  368. Video Card?
  369.  
  370. AV Option?
  371.  
  372. Inits?
  373.  
  374. Urgency:
  375.  
  376.  
  377.  
  378.  
  379.  
  380.